auかんたん決済

auかんたん決済(随時決済) 利用承諾 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却

EntryTranAuAccept 取引登録

これ以降の利用承諾で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

URL
/payment/EntryTranAuAccept.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001
レスポンス
正常
AccessID 半角英数記号32桁 固定
取引ID

AccessPass 半角英数記号32桁 固定
取引パスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranAuAccept 決済実行

これ以降の処理で必要となるトークンを返却します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数27桁
オーダーID

SiteID 半角英数13桁 固定
サイトID

会員ID指定時は必須です。

SitePass 半角英数64桁
サイトパスワード

会員ID指定時は必須です。

MemberID 半角英数記号60桁
会員ID

決済する対象の会員IDを設定します。

MemberName 全半角255桁
会員名

登録する名前を設定します。

CreateMember 半角数字1桁 固定
会員作成フラグ

会員が存在しない場合の動作を指定します。

0：登録しない
会員が存在しない場合、エラーを返す
1：登録する
会員が存在しない場合、新規登録する

会員ID指定時は必須です。

ClientField1 全半角100バイト
加盟店自由項目１

ClientField2 全半角100バイト
加盟店自由項目２

ClientField3 全半角100バイト
加盟店自由項目３

Commodity 必須 全角48バイト
摘要

お客様が購入する商品の情報を設定します。
KDDIセンターでの決済時に表示されます。

RetURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。
KDDIセンター上でお客様が認証、支払操作をキャンセルした場合や、当サービスにて決済処理を実行した場合に指定されたURLに結果をリダイレクト経由で送信されます。

PaymentTermSec 半角数字5桁
支払開始期限秒

お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。
最大86,400秒（1日）
呼び出しパラメータが空の場合、120秒で処理されます。

ServiceName 必須 全角48バイト
表示サービス名

加盟店様のサービス名称です。
お客様の購入履歴などに表示されます。

ServiceTel 必須 半角数字記号15桁
表示電話番号

加盟店様の電話番号です。
お客様の購入履歴などに表示されます。
設定可能な文字は「半角数字と"-"(ハイフン)」です。

URL
/payment/ExecTranAuAccept.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&SiteID=tsite11223344&SitePass=PASSWORD&Commodity=テスト摘要&RetURL=https://example.com/receive&ServiceName=テスト表示サービス名&ServiceTel=03-0000-0000
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

Token 半角英数記号256桁
トークン

アクセスIDのハッシュ値を返却します。

StartURL 半角英数記号256桁
支払手続き開始IFのURL

支払手続き開始IFのURLを返却します。

StartLimitDate 半角数字14桁 固定
支払開始期限日時

支払手続き開始IFの呼び出し期限を返却します。
yyyyMMddHHmmss書式

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.mul-pay.jp/payment/AuAcceptStart.idPass&StartLimitDate=20190225162711
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

AuAcceptStart 利用承諾手続き開始IF呼び出し

お客様をau ID認証画面へ誘導します。
※取引が特定できない場合、すでに利用承諾を済ませている場合、期限切れの場合等はエラー画面を表示します。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID

Token 必須 半角英数記号256桁
トークン

URL
/payment/AuAcceptStart.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL
リダイレクトページサンプル

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="AuAcceptStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
    <noscript>
      <br>
      <br>
      <center>
        <h2>
          auの利用承諾画面へ遷移します。
        </h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script>
    <!--
      function OnLoadEvent() {
        document.AuAcceptStartCall.submit();
      }
    //-->
    </script>
    </body>
</html>

利用承諾結果受信

KDDIセンターから、当サービスに認証・利用承諾操作結果が通知されます。
認証・利用承諾操作結果は、お客様が利用承諾操作を完了した場合と認証・利用承諾操作をキャンセルした場合に通知されます。
当サービスは、【利用承諾実行】時に指定されたリダイレクトURLに利用承諾結果を通知します。
この利用承諾結果は、KDDIセンターの利用承諾完了画面からブラウザ経由で連携されるため、ユーザの操作方法によっては利用承諾操作が完了したにもかかわらず、加盟店様に通知されないことがあります。その際はショップ管理画面または結果通知にて確認ください。
また、同様の理由でこの利用承諾結果が複数回加盟店様に通知されることがあります。

レスポンス
正常
ShopID 半角英数13桁 固定
ショップID

OrderID 半角英数27桁
オーダーID

Status
現状態

該当取引の取引状態を返却します。
REGISTER：利用承諾
PAYFAIL：決済失敗

TranDate 半角数字14桁 固定
処理日時

当サービスで処理を実施した日時を返却します。
yyyyMMddHHmmss書式

PayMethod 半角数字2桁
支払方法

支払方法です。
01：合算
02：クレジットカード
06：au PAY カード
お客様がau ID画面で確認できます。

AuAcceptCode 半角数字14桁
au承諾番号

オーソリ処理が正常終了した時に弊社にて払い出す番号です。
随時決済に利用します。

CheckString 半角英数32桁
改ざんチェック文字列

OrderID,AccessID,ShopID,ShopPassを連結しMD5ハッシュした値を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード

AuAcceptUserEnd 利用承諾終了

利用承諾の終了を行います。

同一のお客様が複数の利用承諾を取得されている場合、利用承諾を一つ終了すると他の利用承諾も利用不可となりますのでご注意ください。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

AuAcceptCode 必須 半角英数14桁
au承諾番号

URL
/payment/AuAcceptUserEnd.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&AuAcceptCode=T2222200000000
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status
現状態

処理成功時は以下のステータスが返却されます。
・END：利用承諾終了

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=END
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁
決済方法

33：auかんたん決済(利用承諾)

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=33
レスポンス
正常
Status
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
AUTHPROCESS：認証中
PAYFAIL：決済失敗
REGISTER：利用承諾
END：利用承諾終了

ProcessDate 半角数字14桁
処理日時

処理を実施した日時を返却します。
yyyyMMddHHmmss書式

JobCd
処理区分

REGISTER：利用承諾
END：利用承諾終了

AccessID 半角数字32桁 固定
取引ID

※：同一オーダーIDでも決済手段が異なると、異なった「取引ID」および「取引パスワード」が返却されます。

AccessPass 半角数字32桁 固定
取引パスワード

※：同一オーダーIDでも決済手段が異なると、異なった「取引ID」および「取引パスワード」が返却されます。

SiteID 半角数字13桁
サイトID

MemberID 半角英数記号60桁
会員ID

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

33：auかんたん決済(利用承諾)

AuPayMethod 半角数字2桁
au支払方法

購入に使用されたauかんたん決済の支払方法

AuAcceptCode 半角英数14桁
au承諾番号

ProcessLastDate 半角数字14桁 固定
最終処理日時

利用承諾を行った日時、またはau承諾番号を使用して随時決済を行った日時を返却します。
yyyyMMddHHmmss書式

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=REGISTER&ProcessDate=20190225162711&JobCd=REGISTER&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&SiteID=tsite11223344&MemberID=testMemberID&ClientField1=&ClientField2=&ClientField3=&PayType=33&AuPayMethod=01&AuAcceptCode=T2222200000000&ProcessLastDate=20190225162711
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001